Pencil Spaces API

You can find API specs for the Pencil Spaces API below. If you have any questions, do not hesitate to contact us.

Note: To authenticate requests, provide your API key as a bearer token in any calls to our API. See this guide for more details.

Server

Staging Server

Client Libraries

Curl Shell

users

Create and manage users in your institution

users Operations

Query profiles for all institution users

Query Parameters

pageNumber
Type:integer
min:
1
default:
1

(Optional) - The page number of the items to return. The number of items in a page is controlled by the pageSize parameter.
pageSize
Type:integer
min:
1
max:
100
default:
25

(Optional) - The max number of items to return. Setting a larger pageSize will default to 100 spaces.
filters
Type:string

(Optional) - A base64 encoded string of the filters you wish to apply to the query. See usersFilterSchema for details on all the filters applicable to your query

Responses

Request Example forGET/users

Selected HTTP client: Shell Curl

curl https://staging-apis.pencilapp.com/public/api/users \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

Show Schema

{
  "results": [],
  "pageNumber": 1,
  "pageSize": 1,
  "totalPages": 1,
  "totalRecords": 1
}

Successful response will return an array of users in the given query range.

Create and manage your Spaces

spaces Operations

Get analytics for activity in your Spaces

sessions Operations