cURL
curl -sS -X GET 'https://apipub.firstbasehq.com/scim/v2/Users?startIndex=1&count=100' \
-H 'Authorization: ApiKey YOUR_API_KEY' \
-H 'Accept: application/json'import requests
url = "https://apipub.firstbasehq.com/scim/v2/Users"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://apipub.firstbasehq.com/scim/v2/Users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"totalResults": 102,
"itemsPerPage": 1,
"startIndex": 1,
"Resources": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"addresses": [
{
"country": "US",
"locality": "New York City",
"postalCode": "10123",
"region": "NY",
"streetAddress": "123 Sesame Street\nSuite 103",
"primary": true
}
],
"userName": "jenny.smith@example.com",
"emails": [
{
"value": "jenny.smith@example.com",
"primary": true
}
],
"name": {
"familyName": "Smith",
"givenName": "Jenny"
},
"urn:ietf:params:scim:schemas:extension:firstbase:1.0:User": {
"skipUserActivation": false,
"packageId": "d1b0fd87-5fc9-410c-b641-0b7146896ccd",
"startDate": "2022-02-01",
"endDate": "2026-01-31",
"status": "ACTIVE",
"cpfNumber": "87456236985",
"accessLevel": "BASIC"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:firstbase:1.0:User"
],
"phoneNumbers": [
{
"value": "1+555-867-5309",
"primary": true
}
]
}
],
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}People
List people
Returns a paginated SCIM ListResponse of people in the caller’s organization. Filter by email address or name using SCIM filter expressions. Maximum of 50 users per page.
GET
https://apipub.firstbasehq.com
/
scim
/
v2
/
Users
cURL
curl -sS -X GET 'https://apipub.firstbasehq.com/scim/v2/Users?startIndex=1&count=100' \
-H 'Authorization: ApiKey YOUR_API_KEY' \
-H 'Accept: application/json'import requests
url = "https://apipub.firstbasehq.com/scim/v2/Users"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://apipub.firstbasehq.com/scim/v2/Users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"totalResults": 102,
"itemsPerPage": 1,
"startIndex": 1,
"Resources": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"addresses": [
{
"country": "US",
"locality": "New York City",
"postalCode": "10123",
"region": "NY",
"streetAddress": "123 Sesame Street\nSuite 103",
"primary": true
}
],
"userName": "jenny.smith@example.com",
"emails": [
{
"value": "jenny.smith@example.com",
"primary": true
}
],
"name": {
"familyName": "Smith",
"givenName": "Jenny"
},
"urn:ietf:params:scim:schemas:extension:firstbase:1.0:User": {
"skipUserActivation": false,
"packageId": "d1b0fd87-5fc9-410c-b641-0b7146896ccd",
"startDate": "2022-02-01",
"endDate": "2026-01-31",
"status": "ACTIVE",
"cpfNumber": "87456236985",
"accessLevel": "BASIC"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:firstbase:1.0:User"
],
"phoneNumbers": [
{
"value": "1+555-867-5309",
"primary": true
}
]
}
],
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}Authorizations
Query Parameters
Fetch user with a given name or email address using SCIM operators
Examples:
emails.value eq "test@email.com"
name.givenName eq "James" and name.familyName eq "Bond"
Response
List of users