For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Help CenterOpenAPI SpecStatus
OverviewInquiriesTransactionsAPI ReferenceChangelog
OverviewInquiriesTransactionsAPI ReferenceChangelog
  • Getting Started
    • Introduction
    • Quickstart Tutorial
  • API Overview
    • API Keys
    • Authentication
    • Protocol
    • Response Body
    • Idempotence
    • Pagination
    • Rate Limiting
    • Downloading Files
    • API Logs
    • Request IDs
  • Versioning
    • API Changelog
    • Versioning
  • Troubleshooting
    • Error Handling
  • API Reference
    • OpenAPI Specification
    • Cases
    • Connect
    • Documents
      • POSTCreate a Graph Query
      • GETRetrieve a Graph Query
    • Inquiries
    • List Items
    • Lists
    • OAuth
    • Reports
    • Transactions
    • Verifications
    • Workflows
  • Webhooks
LogoLogo
Help CenterOpenAPI SpecStatus
API ReferenceGraph

Create a Graph Query

POST
https://api.withpersona.com/api/v1/graph-queries
POST
/api/v1/graph-queries
$curl -X POST https://api.withpersona.com/api/v1/graph-queries \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "data": {
>    "attributes": {
>      "graph-query-template-id": "string"
>    }
>  }
>}'
1{
2  "data": {
3    "type": "graph-query",
4    "id": "grphq_prM3gdSL6ciwGjSjj4aXgKJT",
5    "attributes": {
6      "status": "submitted",
7      "params": {
8        "<query-key>": "<query params>"
9      },
10      "created-at": "2023-09-1T06:30:44.000Z"
11    }
12  }
13}
Create a Graph Query
Was this page helpful?
Previous

Retrieve a Graph Query

Next
Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

includestringOptional
A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details.
fieldsmap from strings to stringsOptional
Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details.

Request

This endpoint expects an object.
dataobjectRequired
metaobjectOptional

Response

This endpoint returns a Graph Query object and (optionally) its related objects in included.

dataobject
A Graph Query object
includedlist of objects

Optional included resources, requested via the include query parameter.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error

A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details.

Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details.