Contacts REST

Use a Project Access Token to create and read People from your backend. The API base URL is https://api-external.svit.one.

Authentication

Create a token in the Project's Access tokens settings. Keep it secret and use it only from your backend. Every request operates in the token's project.

Authorization: Bearer <project-access-token>

Create a Person

Send POST /api/v1/external/people with the Authorization header and a JSON body:

{
    "name": "Ada Lovelace",
    "emails": ["ada@example.test"],
    "phones": ["+380501112233"]
}

201 returns the created Person. Save its id for reads (response excerpt):

{ "id": "person-id", "name": "Ada Lovelace" }

Get a Person

Replace :personId with the returned ID, URL-encoded as a path segment:

GET /api/v1/external/people/:personId
Authorization: Bearer <project-access-token>

200 returns the Person from the token's project.

Important notes

• Repeated plain POST requests (without externalAssociation) can create duplicates. After a timeout or server error, check the result before retrying.
• These endpoints support People, not Organizations. Archived People remain readable; deleted, missing and foreign-project IDs return 404.
• emails and phones are arrays of strings.

See the API reference for complete request fields, responses and errors.

For optional stable source identity and exact-key recovery, see Person external associations.

Token rotation and revocation

In Access tokens, create a replacement, update your backend secret, then delete the old token to revoke it. An enabled expiry date also limits access.