> For the complete documentation index, see [llms.txt](https://docs.coupler.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.coupler.io/api/credentials.md).
# Credentials
## List Credentials
> Returns credentials the current user can use in a workspace: credentials they\
> created, and credentials shared in the workspace. The list contains at most 200\
> credentials, newest first.\
> \
> Each item has \`id\`, \`type\` (\`source\` or \`destination\`), \`provider\`, \`name\`, and\
> \`status\` (\`active\` or \`error\`). \`name\` is the credential title, email, or both.\
> \
> \`setup\_url\` is the Coupler.io page where a user connects a credential. Pass\
> \`provider\` to open that provider. Pass \`type=destination\` to open destination\
> connections. Omit both to open source connections.\
> \
> An unknown \`provider\` or \`type\` returns 400. Guests receive 403 with \`Forbidden\`.
```json
{"openapi":"3.1.0","info":{"title":"Coupler.io Public API","version":"v1"},"servers":[{"url":"https://api.coupler.io"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Bearer token: a personal API token or an OAuth access token."}},"schemas":{"credentials.collection.response":{"type":"object","properties":{"credentials":{"type":"array","description":"Credentials the current user can use in the workspace. At most 200, newest first","items":{"$ref":"#/components/schemas/credentials.item.response"}},"setup_url":{"type":"string","description":"Coupler.io page where a user connects a credential. Includes the provider when `provider` is passed. Otherwise opens source connections, or destination connections when `type` is destination"}},"required":["credentials","setup_url"]},"credentials.item.response":{"type":"object","properties":{"id":{"type":"integer","description":"Credential id"},"type":{"type":"string","enum":["source","destination"],"description":"source for a data source connection, destination for a data destination connection"},"provider":{"type":"string","description":"Provider key, for example google_spreadsheet"},"name":{"type":"string","description":"Credential title, email, or both. Falls back to Credential # when neither is set"},"status":{"type":"string","enum":["active","error"],"description":"active when the credential has no error, error otherwise"}},"required":["id","type","provider","name","status"]},"error_response":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}},"required":["error"]}}},"paths":{"/v1/workspaces/{workspace_id}/credentials":{"get":{"summary":"List Credentials","tags":["Credentials"],"parameters":[{"name":"workspace_id","in":"path","required":true,"description":"Id of the workspace. Use an id returned by GET /v1/workspaces.","schema":{"type":"string"}},{"name":"provider","in":"query","required":false,"description":"Credential provider key. Examples: google_spreadsheet, salesforce, destination_big_query. Omit it to return every provider.","schema":{"type":"string"}},{"name":"type","in":"query","required":false,"description":"Credential type. source for data source connections, destination for data destination connections. Omit it to return both.","schema":{"type":"string","enum":["source","destination"]}}],"description":"Returns credentials the current user can use in a workspace: credentials they\ncreated, and credentials shared in the workspace. The list contains at most 200\ncredentials, newest first.\n\nEach item has `id`, `type` (`source` or `destination`), `provider`, `name`, and\n`status` (`active` or `error`). `name` is the credential title, email, or both.\n\n`setup_url` is the Coupler.io page where a user connects a credential. Pass\n`provider` to open that provider. Pass `type=destination` to open destination\nconnections. Omit both to open source connections.\n\nAn unknown `provider` or `type` returns 400. Guests receive 403 with `Forbidden`.\n","responses":{"200":{"description":"credentials for the workspace","content":{"application/json":{"schema":{"$ref":"#/components/schemas/credentials.collection.response"}}}},"400":{"description":"type is not source or destination","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_response"}}}},"401":{"description":"missing or invalid API token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_response"}}}},"403":{"description":"workspace is not accessible","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_response"}}}}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.coupler.io/api/credentials.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.