Skip to main content
POST
/
api
/
v1
/
companies
/
{company_id}
/
members
/
by-email
Add Company Member By Email
curl --request POST \
  --url http://localhost:8000/api/v1/companies/{company_id}/members/by-email \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com"
}
'
{
  "id": 123,
  "user_id": 123,
  "company_id": 123,
  "date_added": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
company_id
integer
required

Body

application/json

Schema for adding a member to a company. Either user_id or email must be provided.

​
email
string<email>
required

Response

Successful Response

The schema for a company membership.

​
id
integer
required
​
user_id
integer
required
​
company_id
integer
required
​
date_added
string<date-time>
required