Retrieve

This endpoint is for retrieving the details of a specific project using the project ID.

Header Parameters
apiToken string — REQUIRED Secret key for the project

Responses
200 Project details retrieved successfully Schema — OPTIONAL success boolean Indicates if the request was successful. data object token object — OPTIONAL project string — OPTIONAL Project identifier associated with the token. name string — OPTIONAL Name associated with the token. secretKey string — OPTIONAL Secret key for the project's token. publicKey string — OPTIONAL Public key for the project's token. project object — OPTIONAL owner string — OPTIONAL Identifier for the owner of the project. name string — OPTIONAL Name of the project. business_name string — OPTIONAL Registered business name of the project. is_registed boolean — OPTIONAL Indicates if the project is officially registered. logo_url uri — OPTIONAL URL to the logo of the project. services string[] — OPTIONAL List of services offered by the project. currency string — OPTIONAL The currency that the project operates in. email email — OPTIONAL Contact email address for the project. phone_number string — OPTIONAL Contact phone number for the project. webhooks object[] — OPTIONAL name string Name of the webhook. service string Service associated with the webhook. event string Event type that triggers the webhook. url uri URL where the webhook payload will be sent. active boolean Whether the webhook is active. _id string — OPTIONAL Unique identifier for the webhook. secret string — OPTIONAL Secret for the webhook. status string — OPTIONAL The current status of the project. deleted boolean — OPTIONAL Indicates if the project has been deleted. description string — OPTIONAL A brief description of the project. identifier string — OPTIONAL Unique identifier for the project. permissions string[] — OPTIONAL List of permissions assigned to the project. createdAt date-time — OPTIONAL The date and time when the project was created. updatedAt date-time — OPTIONAL The date and time when the project was last updated. __v integer — OPTIONAL Version number of the project. id string — OPTIONAL Unique identifier for the project. message string A message accompanying the response.
400 Bad request, such as invalid input Schema — OPTIONAL code int32 Error code representing the type of error. message string Error message detailing what went wrong.
401 Unauthorized access Schema — OPTIONAL code int32 Error code representing the type of error. message string Error message detailing what went wrong.
404 Project not found Schema — OPTIONAL code int32 Error code representing the type of error. message string Error message detailing what went wrong.
500 Internal Server Error Schema — OPTIONAL code int32 Error code representing the type of error. message string Error message detailing what went wrong.