Get started
Public API
User management

Downloading users list

Official SCIM documentation

https://datatracker.ietf.org/group/scim/documents/

Downloading users

To query users use following url with valid access token in Authorization header:

GET https://masterplan.com/public_api/scim/v2/Users

Optional query parameters:

Parameter Description Default
startIndex Index of first result. 1
count Number of users to retrieve per page 25
filter String with the structure specified in the official documentation.
Currently supported fields are email, first_name, last_name, username.		 None

Example curl command for obtaining users list:

curl -X GET https://masterplan.com/public_api/scim/v2/Users \
     -H 'Authorization: Bearer ACCESS_TOKEN'

Server responds with List of User resources.

Example response

{
    "Resources": [
        {
            "active": true,
            "emails": [
              {
                "primary": true,
                "type": "work",
                "value": "johndoe@example.com"
              }
            ],
            "external_id": "kxzpnRDKNtFgRVa_eygO9LWIJeGKOXqXSrYIfowsxS8",
            "id": "d3a1177f-a9f0-4027-83a4-80d06368fcf3",
            "meta": {
                "created": "2023-05-14T22:18:16.572467+00:00",
                "location": "https://masterplan.com/public_api/scim/v2/Users/d3a1177f-a9f0-4027-83a4-80d06368fcf3",
                "resourceType": "User"
            },
            "name": {
                "familyName": "John",
                "givenName": "Doe"
            },
            "schemas": [
                "urn:ietf:params:scim:schemas:core:2.0:User"
            ],
            "userName": "johndoe@example.com",
            "phoneNumbers": [
                {
                  "primary": true,
                  "type": "work",
                  "value": "123-8800-12"
                }
            ],
            "roles": [
                "manager"
            ],
            "title": "Mr",
            "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
                "department": "Backend"
            },
            "urn:masterplan:scim:UserAttributes": {
                "licenses": 10
            },
            "userType": "Engineering Lead"
        }
    ],
    "itemsPerPage": 1,
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
        "urn:masterplan:scim:UserAttributes"
    ],
    "startIndex": 1,
    "totalResults": 20
}
PAGE CONTENT