Snapbar Studio is a service that allows clients to collect and maintain headshot photos for their employees, guests, or users. The Admin API uses GraphQL for communicating with the service. This documentation does not cover the full extent of API functionality. Fetch the GraphQL schema via introspection (see below) for a full list of queries, objects, and mutations.
\nEvery resource within the API is accessed through a single POST request to the following URL:
\nhttps://headshots.snapbar.com/api/v1/graphql
In order to access the API you must first obtain an access token. This can be accomplished by reaching out to your Account Manager at Snapbar. They will properly configure access scopes for authorization needs. Requests are made using the Authorization header while passing along to the token as Bearer. Example:
Authorization: Bearer your-access-token
The easiest way to explore the API is through our GraphiQL interface hosted at https://headshots.snapbar.com/graphiql. Note you'll need to authenticate with your Snapbar account and select an account before making queries.
\nThe examples provided in this document do not include every accessible object within the API. For a complete list, the API supports standard GraphQL introspection. We highly recommend syncing the schema into your tool of choice for exploring various queries and mutations, which is supported by Postman.
\nA majority of the list type queries have the ability to paginate with a cursor-based Relay-style pagination system (read more). Those without the cursor argument output the full list of objects. A few of the list type queries also allow for sorting keys and sort direction. Those will be noted in the documentation for those queries.
\nAlthough it may be possible to filter by date, the more reliable way to poll for new nodes with a query is to use our cursor-based pagination method. You'll need a way to store the last processed cursor in some stateful store like a database or caching system. It's worth noting that cursors are not unique to the resource/node, but rather in relation to the query you've requested. In other words - if you change your query or sorting key by a non-stable field (e.g. updatedAt), the cursors for the resulting nodes are subject to change. It's best to sort by a key that isn't bound to change (e.g. createdAt or submittedAt).
Let's look at an example to poll for newly accepted submissions.
\nFirst, process all existing submissions:
\nquery {\n submissions(first: 50, state: ACCEPTED, sortDirection: ASC, sortBy: SUBMITTED_AT) {\n edges {\n node {\n id\n }\n cursor\n }\n pageInfo {\n hasNextPage\n endCursor\n }\n }\n}\n\nExample response:
\n{\n \"data\": {\n \"submissions\": {\n \"edges\": [\n {\n \"node\": {\n \"id\": \"gid://holar/Submission/61983604ff402800015a8d9f\"\n },\n \"cursor\": \"MQ\"\n },\n ...\n {\n \"node\": {\n \"id\": \"gid://holar/Submission/631f7bcb49dfcf00015ffb8e\"\n },\n \"cursor\": \"NTA\"\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": true,\n \"endCursor\": \"NTA\"\n }\n }\n }\n}\n\nStore the endCursor in a data store (e.g. database / cache) for future queries. Get the next page, sending the after variable based on the endCursor value:
query {\n submissions(after: \"NTA\", first: 50, state: ACCEPTED, sortDirection: ASC, sortBy: SUBMITTED_AT) {\n edges {\n node {\n id\n }\n cursor\n }\n pageInfo {\n hasNextPage\n endCursor\n }\n }\n}\n\nExample response:
\n{\n \"data\": {\n \"submissions\": {\n \"edges\": [\n {\n \"node\": {\n \"id\": \"gid://holar/Submission/631f7bcb49dfcf00015lfb72\"\n },\n \"cursor\": \"QzR\"\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": false,\n \"endCursor\": \"QzR\"\n }\n }\n }\n}\n\nSince hasNextPage is false, we know we've reached the end of the list. Continue polling (e.g. every hour/day) with cursor \"QzR\" until new results are found. When new submissions are accepted between polls, a new set of edges appear, resulting in a new endCursor. In this way we can process new submissions and avoid re-processing old ones.
Get the details for a specific Studio.
\nRequires headshots:studio:view permissions
Get a list of Studios. See Get Studio for the full studio object.
Requires headshots:studio:view permissions.
Search for a Studio. Search criteria is by studio handle or name, and the response will return back the best possible matches.
\nRequires headshots:studio:view permissions.
Check if a Studio exists. Returns a boolean if a studio handle exists or not.
\nNo specific permissions are required.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"d8a829e3-22d4-4482-ae77-e5edaae6c321","id":"d8a829e3-22d4-4482-ae77-e5edaae6c321","name":"Snapbar Studio Admin API (Private BETA)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","graphql"],"host":["headshots","snapbar","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3bc02ea7-e3ac-4025-b60e-d701b96db235"}],"id":"9e63e72e-e84f-40ed-a7b2-01e7335b5bdf","description":"Account-level tokens only have the ability to read from the studio object. Only studios under the account are able to be found by the associated token. The studio object is expanded on the GetStudio query.
Requires headshots:studiosession:view scope
Requires headshots:studiosession:add scope. studioId and email are required fields. studioUrl is the URL of the studio to be accessed. Default is the global studio URL.
Requires headshots:studiosession:delete scope.
Requires headshots:preset:view scope.
Requires headshots:preset:view scope. Does not filter and/or paginate
Requires headshots:contact:view scope.
Returns the contact attributes for the account the token is associated with.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"d8a829e3-22d4-4482-ae77-e5edaae6c321","id":"d8a829e3-22d4-4482-ae77-e5edaae6c321","name":"Snapbar Studio Admin API (Private BETA)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","graphql"],"host":["headshots","snapbar","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"50ac2a23-0b6e-4de6-a555-9f1622a46861"},{"name":"List Contacts","id":"8b5a4d6b-d8dc-4a94-90d8-e137b8908cff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"query ListContacts($cursor: String){\n contactItems(first:5, after: $cursor) {\n edges {\n node {\n id\n email\n firstName\n lastName\n }\n cursor\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n }\n}","variables":"{\n \"cursor\": null\n}"}},"url":"https://headshots.snapbar.com/api/v1/graphql","description":"Requires headshots:contact:view scope. Allows for sortBy on the following values FIRST_NAME, LAST_NAME, EMAIL, CREATED_AT, UPDATED_AT, and SUBMISSIONS_COUNT. Allows for sortDirection withASC and DESC.
This is the same query as List Contacts but is demonstrating the ability to only return contacts from a specific contact list.
Requires headshots:contact:view scope. Search for a contact by first name, last name, or email.
Requires headshots:contact:add scope. The field customAttributes is key-value pairs for existing custom contact attributes.
Requires headshots:contact:add scope. This mutation exists for the use case of sending your own invitation emails. The access URL does not expire so long as the contact and stuiod exist.
Requires headshots:contact:view scope.
Requires headshots:contact:view scope.
Requires headshots:contact:add scope.
Requires headshots:studiosession:addscope. New contact records will be created if an email given does not match a current contact.
Requires headshots:studiosession:addscope.
Requires headshots:submission:viewscope.
Requires headshots:submission:viewscope.
The values for downloadUrl and publicUrl are temporary asset URLs that expire after 1 hour. Do not use these URLs for long-term external reference.