developer.indexingRequests

GET

/v1/developer/indexing

const url = 'https://example.com/v1/developer/indexing';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/developer/indexing \
  --header 'Authorization: Bearer <token>'

Authorizations

token
session

Parameters

Query Parameters

cardUrl

string

Responses

200

Success

application/json

Array<object>

object

required

string

executionId

required

string

>= 1 characters <= 128 characters

cardUrl

required

string

generation

required

string

acceptedAt

required

number

status

required

string

Allowed values: Accepted Waiting Verifying Completed

check

required

Any of:

object

_tag

required

string

Allowed values: Pending

restriction

required

Any of:

object
null

object

cardUrl

required

string

reason

required

string

>= 1 characters

appealUrl

required

string

Example

[
  {
    "status": "Accepted",
    "check": {
      "_tag": "Pending"
    }
  }
]

400

DeveloperInputInvalid | OrganizationRequired

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: DeveloperInputInvalid

message

required

string

keys

Array<string>

Example

{
  "_tag": "DeveloperInputInvalid"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

application/json

Any of:

object

_tag

required

string

Allowed values: ExecutionForbidden

Example

{
  "_tag": "ExecutionForbidden"
}

404

ExecutionNotFound | DeveloperNotFound

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: ExecutionNotFound

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExecutionNotFound"
}

409

ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending

application/json

Any of:

object

_tag

required

string

Allowed values: ExecutionConflict

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExecutionConflict"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: ExecutionUnavailable

errorId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExecutionUnavailable"
}