tebarDocs
GuideDevelopersAPI ReferenceChangelog
Profiles

Get a profile

GET
/v1/profiles/{id}

Requires the read scope. Owner key or session only: a profile key gets 403 owner_key_required.

Authorization

bearer
headerAuthorizationBearer <token>

An API key (tb_live_...) from the dashboard, or an OAuth access token.

Path Parameters

id*string
Formatuuid

Response Body

The profile.

application/json
  1. response
id*string
Formatuuid
name*string
external_id*|

The client's id in your own system.

is_default*boolean
created_at*string
Formatdate-time
Example Request
curl -X GET 'https://api.tebar.app/v1/profiles/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "external_id": "string",
  "is_default": true,
  "created_at": "2019-08-24T14:15:22Z"
}

Create a profile POST

An external_id already in use returns that profile with 200, so the request is safe to repeat. Free plan: 403 plan_required; more than 1,000 profiles: 422 profile_limit. Requires the write scope. Owner key or session only: a profile key gets 403 owner_key_required.

Update a profile PATCH

external_id null removes it; one used by another profile: 409 external_id_taken. Requires the write scope. Owner key or session only: a profile key gets 403 owner_key_required.