API Gateway

Find Contacts

Retrieve some public contact. Normal users can only search specific email/ids

post/v2/contacts

Request

Base URL
https://api.studio.prisme.ai
Auth
- HTTP bearer
- or API key in header x-prismeai-api-key
- or HTTP bearer and API key in header x-prismeai-api-key
TypeScript
https://skmtc.dev/prisme/apis/prisme-ai-apis/docs/v2/contacts/post.ts
A function with typed inputs. Its response is checked against the schema.

pagenumber

Page number

limitnumber

Page size

createdBeforestring

User signed up before that date (ISO8601), reserved to super admins

createdAfterstring

User signed up before that date (ISO8601), reserved to super admins

orgSlugstring

Filter users by organization slug, reserved to super admins / root

emailstring

textstring

Search in both email & id

idsstring[]

firstNamestring

lastNamestring

authProviderstring

status'pending' | 'validated' | 'deactivated'

platformRolestring

groupsstring[]

includeOrgMembershipstring

Org slug — enrich contacts with membership data from this org (requires super admin or org admin permissions)

Success Response

sizenumber

Total number of matching contacts

No recorded changes to this operation across all 1 revision of this API.