Credential Requests

The following endpoints allow you to manage credential requests for connections and keys. You can create requests, list them, view details, and manage individual credentials within requests.

List Credential Requests

get
/credential-requests/requests

Retrieves a list of Credential Requests.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Query parameters
teamIdintegerRequired

Team ID to filter credential requests.

userIdnumberOptional

User ID to filter credential requests.

makeProviderIdnumberOptional

Make Provider ID to filter credential requests.

statusstring · enumOptional

Status to filter credential requests.

Possible values:
namestring · max: 255Optional

Name to filter credential requests.

Responses
chevron-right
200

List of Credential Requests.

application/json
get
/credential-requests/requests
200

List of Credential Requests.

Deprecated

Create new Credential Request - deprecated

post
/credential-requests/requests

Creates a new request for Credentials. Supports two flows: 1) Flow for new Make users, 2) Flow for existing Make users.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Body

Request body for creating a new Credential Request. Supports two provider flows - inviting a new user or referencing an existing Make user.

namestring · max: 255Required

Name of the Request which will be displayed to the End Users who open it.

teamIdnumberRequired

ID of the Team the Credential Request should be bound to.

descriptionstring · max: 512Optional

Description of the Request which will be displayed to the End Users who open it.

providerone ofRequired

Provider information. Either an existing Make user ID or a new user to invite (name & email).

or
Responses
chevron-right
200

Credential Request has been created successfully.

application/json
publicUristring · uriRequired

Public URI where the provider can access the credential request.

post
/credential-requests/requests
200

Credential Request has been created successfully.

Create new Credential Request (V2)

post
/credential-requests/requests/v2

Creates a new request for Credentials using app and module selections. Credentials (connections/keys) are automatically derived from the selected modules using the modules-with-credentials API.

Supports two provider flows:

  1. Existing Make user - Reference an existing Make user by their ID. The user will be added to the team if not already a member.

  2. New user invitation - Invite a new user by providing their name and email.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Body

V2 Request body for creating a Credential Request. Credentials are derived from app and module selections.

namestring · max: 255Required

Name of the Request which will be displayed to the End Users who open it.

teamIdinteger · min: 1Required

ID of the Team the Credential Request should be bound to.

descriptionstring · max: 512Optional

Description of the Request which will be displayed to the End Users who open it.

providerone ofRequired

Provider information. Either an existing Make user ID or a new user to invite (name & email).

or
Responses
chevron-right
200

Credential Request has been created successfully.

application/json

Response for V2 Credential Request creation.

publicUristring · uriRequired

Public URI for accessing the credential request.

post
/credential-requests/requests/v2
200

Credential Request has been created successfully.

Get Credential Request

get
/credential-requests/requests/{requestId}

Retrieves a single Credential Request.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
requestIdstring · uuidRequired

ID of the Credential Request.

Query parameters
Responses
chevron-right
200

Credential Request.

application/json
get
/credential-requests/requests/{requestId}
200

Credential Request.

Delete Credential Request

delete
/credential-requests/requests/{requestId}

Deletes the given Credential Request.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
requestIdstring · uuidRequired

ID of the Credential Request.

Query parameters
confirmedbooleanOptional

When true, also deletes credentials (connections and keys) associated with the credential request. When false or omitted the API will return an error if there are any associated credentials, preventing accidental deletion of credentials.

Responses
chevron-right
200

Credential Request has been deleted successfully.

application/json
deletedbooleanOptional

Indicates if the request was deleted.

delete
/credential-requests/requests/{requestId}
200

Credential Request has been deleted successfully.

Get Credential Request Detail

get
/credential-requests/requests/{requestId}/detail

Retrieves detail of a single Credential Request with associated credentials. This endpoint has been enhanced to include all credentials associated with the request in a single response, eliminating the need for additional API calls.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
requestIdstring · uuidRequired

ID of the Credential Request.

Responses
chevron-right
200

Detail of the Credential Request with associated credentials.

application/json
get
/credential-requests/requests/{requestId}/detail
200

Detail of the Credential Request with associated credentials.

Decline Credential

post
/credential-requests/credentials/{credentialId}/decline

Declines a credential by setting its state to declined and recording the reason. This endpoint is idempotent and can be used to update the decline reason of an already declined credential.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
credentialIdstring · uuidRequired

ID of the Credential.

Query parameters
Body
reasonstring · min: 1 · max: 2048Optional

The reason why the credential was declined. This will be visible to support teams and helps with troubleshooting.

Responses
chevron-right
200

Credential has been declined successfully.

application/json
post
/credential-requests/credentials/{credentialId}/decline
200

Credential has been declined successfully.

Delete Remote Credential

post
/credential-requests/credentials/{credentialId}/delete-remote

Deletes a credential from the remote platform (Make Web API) and resets its state to pending. The credential can then be re-created through the normal creation flow.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
credentialIdstring · uuidRequired

ID of the Credential.

Query parameters
Responses
chevron-right
200

Credential has been deleted from remote and reset to pending.

application/json
post
/credential-requests/credentials/{credentialId}/delete-remote
200

Credential has been deleted from remote and reset to pending.

Request Credential Reauthorization

post
/credential-requests/credentials/{credentialId}/request-reauthorize

Tests the OAuth connection and transitions to reauthorizing state if invalid. Returns an error if the connection is still valid.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
credentialIdstring · uuidRequired

ID of the Credential.

Query parameters
Responses
chevron-right
200

Credential transitioned to reauthorizing state.

application/json
post
/credential-requests/credentials/{credentialId}/request-reauthorize
200

Credential transitioned to reauthorizing state.

Last updated