---
updatedAt: 2025-06-09T23:42:12.000Z
agentTools:
  projectIndex: https://docs.tarabut.com/llms.txt
---

# Get Intent

Enables you to get information about an existing intent

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Connect",
    "description": "APIs for the Tarabut sandbox environment. Before you begin, please create the 'clientId' and 'clientSecret' from Tarabut Dev Portal.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.sau.sandbox.tarabutgateway.io"
    }
  ],
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "Your access token generated from the [Create Access Token](https://docs.tarabut.com/v2.0/reference/createaccesstokenv2) endpoint, the access token will contain `X-TG-CustomerUserId` that was added when the token was generated"
      }
    }
  },
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "paths": {
    "/accountInformation/v1/intent/{intentId}": {
      "get": {
        "tags": [
          "Connect"
        ],
        "summary": "Get Intent",
        "description": "Enables you to get information about an existing intent",
        "operationId": "getIntent",
        "parameters": [
          {
            "name": "Content-Type",
            "in": "header",
            "schema": {
              "type": "string",
              "description": "Specify the body format to JSON format",
              "default": "application/json"
            },
            "required": true
          },
          {
            "name": "intentId",
            "in": "path",
            "schema": {
              "type": "string",
              "description": "The `intentId` that has been returned from the [Create Intent](https://docs.tarabut.com/v2.0/reference/createintent) endpoint"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "intentId",
                    "intentStatus"
                  ],
                  "properties": {
                    "intentId": {
                      "type": "string",
                      "description": "The intentId",
                      "example": "092d24cc-4691-460d-a33b-f54f0b26403c"
                    },
                    "providerId": {
                      "type": "string",
                      "description": "The unique identifier of the provider linked to this intentId",
                      "example": "BLUE"
                    },
                    "intentStatus": {
                      "type": "string",
                      "description": "Status of the intent which can be `CREATED`, `INITIATED`,`CONSENT_INITIATED`, `CONSENT_REJECTED`, `CANCELLED_CONSENT_SCREEN`, `COMPLETED`, `EXPIRED`, `CONSENT_REVOKED`, `UNKNOWN`",
                      "example": "COMPLETED"
                    },
                    "consentId": {
                      "type": "string",
                      "description": "Consent ID generated If the intent status is `COMPLETED`, that can be used for [Consent Management](https://docs.tarabut.com/docs/build-your-own-consent-management-dashboard)",
                      "example": "99aa7885-fe3a-4065-9222-c1a0f0917367"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Error response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "error name",
                      "example": "UNAUTHORIZED_ACCESS"
                    },
                    "errorMessage": {
                      "type": "string",
                      "description": "error message",
                      "example": "Not Authenticated"
                    },
                    "traceId": {
                      "type": "string",
                      "description": "Tracing Id used when you contact support",
                      "example": "278827398026513417"
                    },
                    "details": {
                      "type": "array",
                      "description": "The array contains details of the error",
                      "items": {
                        "type": "object",
                        "properties": {
                          "fieldName": {
                            "type": "string",
                            "description": "Field name that has invalid input",
                            "example": "Authorization"
                          },
                          "message": {
                            "type": "string",
                            "description": "Error message of the invalid input",
                            "example": "Missing bearer token"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```