Skip to content

Start building

Jump toSign-in apps
All endpoints

Sign-in apps

Your organization's own OAuth apps, used when a tool signs in.

get/v1/oauth_apps

List OAuth apps

Needs connection.view

Every app (a handful per organization), with who registered and last changed it and how many connections signed in through it.

Response200

  • objectstring
    list
  • dataOAuthApp[]
    12 fields
    • idstring
    • objectstring
      oauth_app
    • appstring
    • client_idstring
    • created_atstring
    • namestring
    • redirect_uristring
    • statusstring
      One ofpendingactivedisabled
    • connectionsinteger or null
    • created_byActorRef or null

      Who created or last changed something, resolved to a name for display. system, workload (an automation) and end_user (a widget visitor) have no ID or name: the console words them. name is null for someone the directory no longer knows. id is what the lists' created_by/updated_by filters take. avatar_version is set for a person with a photo: it is at GET /v1/members/{id}/avatar?v=<avatar_version> while they are a member.

      5 fields
      • idstring or null
      • kindstring
        One ofuserapi_keyservice_accountworkloadend_usersystem
      • namestring or null
      • avatar_versionstring or null
      • emailstring or null
    • updated_atstring or null
    • updated_byActorRef or null

      Who created or last changed something, resolved to a name for display. system, workload (an automation) and end_user (a widget visitor) have no ID or name: the console words them. name is null for someone the directory no longer knows. id is what the lists' created_by/updated_by filters take. avatar_version is set for a person with a photo: it is at GET /v1/members/{id}/avatar?v=<avatar_version> while they are a member.

      5 fields
      • idstring or null
      • kindstring
        One ofuserapi_keyservice_accountworkloadend_usersystem
      • namestring or null
      • avatar_versionstring or null
      • emailstring or null
  • has_moreboolean
  • next_cursorstring or null
  • facetsmap<string, map<string, integer>> or null
  • peoplemap<string, ActorRef> or null
    5 fields
    • idstring or null
    • kindstring
      One ofuserapi_keyservice_accountworkloadend_usersystem
    • namestring or null
    • avatar_versionstring or null
    • emailstring or null
  • total_countinteger or null
  • total_count_exactboolean or null

Status codes

  • 200Successful Response
  • 4XXThe request was refused: the problem says why.
  • 5XXThe API could not answer: the problem says why.
Request
curl "https://api.mydeepagents.com/v1/oauth_apps" \
  -H "Authorization: Bearer $MDA_API_KEY"
Response · 200
JSON
{
  "object": "list",
  "data": [
    {
      "id": "oap_01jcsdmh943pdr7ahcbyn0fjsm",
      "object": "oauth_app",
      "app": "app",
      "client_id": "client id",
      "connections": 2,
      "created_at": "2026-11-10T09:30:00.000Z",
      "created_by": {
        "kind": "user",
        "id": "usr_01jcf1j9wjxfrnhqda3mq7ejxn",
        "name": "Ada Lovelace",
        "email": "ada@example.com"
      },
      "name": "Support triage",
      "redirect_uri": "https://example.com",
      "status": "pending",
      "updated_at": "2026-11-10T09:30:00.000Z",
      "updated_by": {
        "kind": "user",
        "id": "usr_01jcf1j9wjxfrnhqda3mq7ejxn",
        "name": "Ada Lovelace",
        "email": "ada@example.com"
      }
    }
  ],
  "has_more": false,
  "next_cursor": null,
  "total_count": 1
}
post/v1/oauth_apps

Create OAuth app

Needs connector.manage

Section 8.3: the row now, the secret sealed by the connector worker (api holds no credentials key). Its redirect URI is the console's fixed callback.

Request bodyOAuthAppCreate

  • appstringRequired
    matches ^[a-z][a-z0-9_]{1,40}$
  • client_idstringRequired
    at least 1 charactersat most 500 characters
  • client_secretstringRequired
    at least 1 charactersat most 2000 characters
  • namestringRequired
    at least 1 charactersat most 200 characters

Response201

  • idstring
  • objectstring
    oauth_app
  • appstring
  • client_idstring
  • created_atstring
  • namestring
  • redirect_uristring
  • statusstring
    One ofpendingactivedisabled
  • connectionsinteger or null
  • created_byActorRef or null

    Who created or last changed something, resolved to a name for display. system, workload (an automation) and end_user (a widget visitor) have no ID or name: the console words them. name is null for someone the directory no longer knows. id is what the lists' created_by/updated_by filters take. avatar_version is set for a person with a photo: it is at GET /v1/members/{id}/avatar?v=<avatar_version> while they are a member.

    5 fields
    • idstring or null
    • kindstring
      One ofuserapi_keyservice_accountworkloadend_usersystem
    • namestring or null
    • avatar_versionstring or null
    • emailstring or null
  • updated_atstring or null
  • updated_byActorRef or null

    Who created or last changed something, resolved to a name for display. system, workload (an automation) and end_user (a widget visitor) have no ID or name: the console words them. name is null for someone the directory no longer knows. id is what the lists' created_by/updated_by filters take. avatar_version is set for a person with a photo: it is at GET /v1/members/{id}/avatar?v=<avatar_version> while they are a member.

    5 fields
    • idstring or null
    • kindstring
      One ofuserapi_keyservice_accountworkloadend_usersystem
    • namestring or null
    • avatar_versionstring or null
    • emailstring or null

Status codes

  • 201Successful Response
  • 422The request is not valid: errors[] names each field.
  • 4XXThe request was refused: the problem says why.
  • 5XXThe API could not answer: the problem says why.
Request
curl -X POST "https://api.mydeepagents.com/v1/oauth_apps" \
  -H "Authorization: Bearer $MDA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "app": "app",
    "client_id": "client id",
    "client_secret": "client secret",
    "name": "Support triage"
  }'
Response · 201
JSON
{
  "id": "oap_01jcsdmh943pdr7ahcbyn0fjsm",
  "object": "oauth_app",
  "app": "app",
  "client_id": "client id",
  "connections": 2,
  "created_at": "2026-11-10T09:30:00.000Z",
  "created_by": {
    "kind": "user",
    "id": "usr_01jcf1j9wjxfrnhqda3mq7ejxn",
    "name": "Ada Lovelace",
    "email": "ada@example.com"
  },
  "name": "Support triage",
  "redirect_uri": "https://example.com",
  "status": "pending",
  "updated_at": "2026-11-10T09:30:00.000Z",
  "updated_by": {
    "kind": "user",
    "id": "usr_01jcf1j9wjxfrnhqda3mq7ejxn",
    "name": "Ada Lovelace",
    "email": "ada@example.com"
  }
}
delete/v1/oauth_apps/{oauth_app_id}

Delete OAuth app

Needs connector.manage

Path parameters

  • oauth_app_idstringRequired

Response204

Answers 204 with no body.

Status codes

  • 204Successful Response
  • 422The request is not valid: errors[] names each field.
  • 4XXThe request was refused: the problem says why.
  • 5XXThe API could not answer: the problem says why.
Request
curl -X DELETE "https://api.mydeepagents.com/v1/oauth_apps/oap_01jcsdmh943pdr7ahcbyn0fjsm" \
  -H "Authorization: Bearer $MDA_API_KEY"

Build with us

Ready for your first call?

Early access is open. Tell us what you want your agents to do, and we will help you get your first key.