Create a team
Creates a team, with its members if you name them. A team's name is unique among your teams that aren't
archived; a second team of the same name returns conflict. Teams are on every plan and count against nothing.
Scope: people:write · Plan: Pro and Enterprise in live mode; every plan in test mode.
AuthorizationBearer <token>Send Authorization: Bearer <token> on every request. The token is one of:
| Prefix | What it is | Where it may be used |
|---|---|---|
agoo_sk_live_ | Secret key, live mode | Your servers only |
agoo_sk_test_ | Secret key, test mode | Your servers only |
agoo_pk_live_ | Publishable key, live mode | Browsers and apps: create pre-registrations and bookings, read public booking types (with their intake questions) and their free slots, read the visit types open for pre-registration with their public forms. Never lists people. |
agoo_pk_test_ | Publishable key, test mode | As above, in test mode |
Admins create keys in Console → Developers → API keys and choose each key's scopes. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.
Scope: people:write
Idempotency-Key*stringA UUID you generate for this operation. If you retry with the same key within 24 hours, Agoo returns the
original response instead of acting twice. While the first request is still running, a retry returns
conflict. Reusing a key with a different request returns idempotency_key_reused. Responses with
rate_limited, internal_error or unavailable aren't stored, so retry those with the same key.
uuidapplication/json- body
name*string1 <= length <= 80site_id?SiteIdLeave out for a team at every site.
^site_[0-7][0-9a-hjkmnp-tv-z]{25}$"site_01kjpt3yw0fz0v414608h9x65s"lead_id?PersonIdA person ID (TypeID with the person prefix).
^person_[0-7][0-9a-hjkmnp-tv-z]{25}$"person_01kjsesxm0e4zbyvkr7bcfxbfg"visitors_can_choose?booleanLet visitors choose this team at the kiosk and on your visitor pages.
falsemember_ids?array<>items <= 500The team.
application/json- response
A team: who a visitor comes to see when it isn't one person, and who a waiting visitor is passed to.
id*TeamIdA team ID (TypeID with the team prefix).
^team_[0-7][0-9a-hjkmnp-tv-z]{25}$"team_01m4r6y616e1b973vj50h0643y"name*stringlength <= 80"Finance"site_id*|The site the team is at. null: every site.
^site_[0-7][0-9a-hjkmnp-tv-z]{25}$lead_id*|The person who leads the team, if you name one.
^person_[0-7][0-9a-hjkmnp-tv-z]{25}$visitors_can_choose*booleanVisitors may choose this team at the kiosk and on your visitor pages.
archived*booleanAn archived team takes no new visits; its past visits keep its name.
members*array<>created_at*stringdate-timeupdated_at*stringdate-timecurl -X POST 'https://api.agoo.ardent.africa/v1/teams' \ -H 'Idempotency-Key: 3f6b2a1e-8c4d-4f7a-9b2e-5d1c0a7e9f64' \ -H 'Content-Type: application/json' \ -d '{ "name": "Finance", "site_id": "site_01kjpt3yw0fz0v414608h9x65s", "visitors_can_choose": true, "member_ids": [ "person_01kjsesxm0e4zbyvkr7bcfxbfg" ]}'{ "id": "team_01m4r6y616e1b973vj50h0643y", "name": "Finance", "site_id": "string", "lead_id": "string", "visitors_can_choose": true, "archived": true, "members": [ { "id": "person_01kjsesxm0e4zbyvkr7bcfxbfg", "name": "string", "job_title": "string", "active": true } ], "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}List teams GET
Returns your teams with their members, newest first. A team is who a visitor comes to see when it isn't one person ("I'm here for Finance"), and who reception passes a waiting visitor to. **Scope:** `people:read` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.
Get a team GET
Returns one team with its members. **Scope:** `people:read` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.