Skip to main content
POST

Authorizations

Authorization
string
header
required

Send your API key as a bearer token: Authorization: Bearer osa_live_…. Keys are opaque; each belongs to exactly one partner. Keys starting with osa_test_ reach only test claims and test accounts. The scopes listed on each operation are the permissions the key needs. A key's permissions are set when it is issued and can be changed by OSA on request, never beyond what your plan and add-ons include. GET /v1/me always shows the current set.

Scopes

members:write

Body

application/json

The person to invite and their role.

The person to invite and their role. invited_as, invited_by, purpose and note are your own notes: nothing is checked against the account, and no invitation is refused because of them.

osa_id
string
required

The OSAID of the person to invite. They can read it in the OSA app.

Required string length: 1 - 128
Example:

"Xk3pQ9vT2mN8rL5wB7yC1dF4gH6j"

role
enum<string>
required

The role you are inviting the person to, as OSA's role kind: not your own title for the role. Open list: more role kinds may be added; only adjuster today. Which roles you can invite depends on your partner type and your setup with OSA; any other value fails with 422 validation_failed.

Available options:
adjuster
Example:

"adjuster"

invited_as
string

Who you believe you are inviting, for example the person's name. Your own note: nothing is checked against the account. It is shown to the person on the invitation.

Required string length: 1 - 200
Example:

"Todd Rivera"

invited_by
string

Who in your organisation sent the invitation. Your own note: nothing is checked against the account, and the person doesn't see it.

Required string length: 1 - 200
purpose
string

What the invitation is for. Your own note: nothing is checked against the account, and the person doesn't see it.

Required string length: 1 - 500
note
string

Anything else you want to record with the invitation. Your own note: nothing is checked against the account, and the person doesn't see it.

Required string length: 1 - 1000

Response

The invitation was sent and is pending.

A member of your organisation, or an invitation you sent.

osa_id
string
required

The person's OSAID.

status
enum<string>
required

pending: invited, not yet answered. active: accepted and a member of your organisation. declined: the person declined. expired: not answered within 7 days. withdrawn: you withdrew the invitation. Open list: new values may be added; treat an unknown value as an unknown state.

Available options:
pending,
active,
declined,
expired,
withdrawn
roles
enum<string>[]
required

The role kinds the person holds in your organisation; empty when none of their roles has a kind. These are OSA's role kinds, not your own titles for the roles.

A role kind: adjuster today. Open list: new values may be added; treat an unknown value as a role you don't specifically handle.

Available options:
adjuster
test
boolean
required

true for one of your OSA-created test accounts.

name
string | null
required

The person's name; null until they accept.

email
string | null
required

The person's email; null until they accept.

invited_at
string<date-time> | null
required

When the invitation was sent; null for members added without an invitation record.

expires_at
string<date-time> | null
required

When a pending invitation expires; null unless pending.

responded_at
string<date-time> | null
required

When the person accepted or declined; null otherwise.

invited_as
string | null
required

Who you said you were inviting; null when not sent. This is your own note, so after acceptance it can differ from the account's real name.

invited_by
string | null
required

Who in your organisation sent the invitation, as you sent it; null when not sent.

purpose
string | null
required

What the invitation is for, as you sent it; null when not sent.

note
string | null
required

Your note on the invitation, as you sent it; null when not sent.