Authentication
WRITE API
- Write
READ API
- Read
PLATFORM API
- OAuth
- Project
- Provider App
- Integration
- Revision
- Installation
- Objects & Fields
- Operation
- Provider
- API Key
- Connection
- Group
- Consumer
- Destination
- Upload URL
- Org
- User
- Billing Account
Accept an invite
curl --request POST \
--url https://api.withampersand.com/v1/invites:accept \
--header 'Content-Type: application/json' \
--data '{
"invitedEmail": "<string>"
}'{
"builder": {
"id": "builder-id-123",
"idpProvider": "clerk",
"idpRef": "<string>",
"createTime": "2023-11-07T05:31:56Z",
"firstName": "<string>",
"lastName": "<string>",
"fullName": "<string>",
"primaryEmail": "<string>"
},
"projectRoles": {},
"orgRole": {
"role": "admin",
"principalType": "team",
"principalId": "builder-id-123",
"org": {
"id": "org-123",
"label": "Acme Inc",
"defaultTeamId": "<string>",
"createTime": "2023-11-07T05:31:56Z",
"updateTime": "2023-11-07T05:31:56Z"
}
}
}Body
The email address that the invite was sent to
Response
The builder ID.
"builder-id-123"
The identity provider
"clerk"
ID used by the identity provider
The time that the builder joined Ampersand.
A map of project IDs to project roles for the builder.
The role of the builder in the project.
"admin"
The type of the principal.
team, builder The ID of the team or builder.
"builder-id-123"
The project ID.
"project-id-123"
The project name.
"mailmonkey-staging"
The name of the application, which is displayed to end users.
"MailMonkey"
The time the project was created.
The organization ID that this project belongs to.
The time the project was updated.
The role of the builder in the org.
"admin"
The type of the principal.
team, builder The ID of the team or builder.
"builder-id-123"
The organization ID.
"org-123"
The organization label.
"Acme Inc"
The ID of the Everyone team for the org.
The time the organization was created.
The time the organization was updated.
curl --request POST \
--url https://api.withampersand.com/v1/invites:accept \
--header 'Content-Type: application/json' \
--data '{
"invitedEmail": "<string>"
}'{
"builder": {
"id": "builder-id-123",
"idpProvider": "clerk",
"idpRef": "<string>",
"createTime": "2023-11-07T05:31:56Z",
"firstName": "<string>",
"lastName": "<string>",
"fullName": "<string>",
"primaryEmail": "<string>"
},
"projectRoles": {},
"orgRole": {
"role": "admin",
"principalType": "team",
"principalId": "builder-id-123",
"org": {
"id": "org-123",
"label": "Acme Inc",
"defaultTeamId": "<string>",
"createTime": "2023-11-07T05:31:56Z",
"updateTime": "2023-11-07T05:31:56Z"
}
}
}