Credentials

The Credential object represents the authentication details required for OAuth2-based integrations. It contains a client ID and client secret which are used to mint access tokens for a user in the OAuth2 system. These client secret must be kept confidential and should not be exposed in client-side applications.

The Credential Object

Schema Credential not found in OpenAPI spec.

Retrieve Credentials

Retrieve all OAuth credentials for a business

Parameters

businessstringPath RequiredField must be in path.

The unique identifier of the business whose credentials should be retrieved.

Returns200

Successfully retrieved the credentials associated with the specified business.

The Credential Object

Endpoint

GET /v2/businesses/{business}/credentials

Retrieve a Credential

Retrieve details of a specific OAuth credential

Parameters

businessstringPath RequiredField must be in path.

The unique identifier of the business that owns the credential.

credentialstringPath RequiredField must be in path.

The unique identifier of the credential to retrieve.

Returns200

Successfully retrieved the specified OAuth credential.

The Credential Object

Endpoint

GET /v2/businesses/{business}/credentials/{credential}

Create a Credential

Create new OAuth credentials for a business

Parameters

businessstringPath RequiredField must be in path.

The unique identifier of the business for which credentials should be created.

Schema undefined not found in OpenAPI spec.

Returns201

Successfully created new OAuth credentials for the specified business. The response contains the client secret, which is only available at the time of creation.

The Credential Object

Endpoint

POST /v2/businesses/{business}/credentials

Delete a Credential

Revoke and delete an OAuth credential for a business

Parameters

businessstringPath RequiredField must be in path.

The unique identifier of the business that owns the credential.

credentialstringPath RequiredField must be in path.

The unique identifier of the credential to be revoked and deleted.

Returns204

Successfully deleted the specified OAuth credential. No content is returned in the response.

Endpoint

DELETE /v2/businesses/{business}/credentials/{credential}