Skip to main content
GET
/
orgs
/
{orgId}
/
builders
List builders for an organization
curl --request GET \
  --url https://api.withampersand.com/v1/orgs/{orgId}/builders \
  --header 'X-Api-Key: <api-key>'
[
  {
    "id": "builder-id-123",
    "idpProvider": "clerk",
    "idpRef": "<string>",
    "createTime": "2023-11-07T05:31:56Z",
    "firstName": "<string>",
    "lastName": "<string>",
    "fullName": "<string>",
    "primaryEmail": "<string>"
  }
]

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
orgId
string
required

ID of the organization.

Response

List of builders that are a part of the org

​
id
string
required

The builder ID.

Example:

"builder-id-123"

​
idpProvider
string
required

The identity provider

Example:

"clerk"

​
idpRef
string
required

ID used by the identity provider

​
createTime
string<date-time>
required

The time that the builder joined Ampersand.

​
firstName
string
​
lastName
string
​
fullName
string
​
primaryEmail
string