List associated Tenants

GET 
/tenants

The "List associated Tenants" section allows users to retrieve a list of tenants associated with their account in the Agility Credit API. By accessing this section, users can easily view and manage tenant information for streamlined operations within the platform.

Request

Header Parameters

Agc-Tenant-Id stringrequired

The tenant ID provided by Agility Credit.

Agc-User-Id stringrequired

The requestor user ID.

Agc-Applicant-Id string

If passed, will assign the report to that applicant. If not, will create a new applicant ID

Responses

200

Tenants

application/json

Schema

Schema

tenantsarray

Example (from schema)

{
  "tenants": [
    null
  ]
}

400

Bad Request

application/json

Schema

Schema

statusstring
errorstring

Example (from schema)

{
  "status": "Bad Request - Invalid Parameters",
  "error": "Failed schema validation. Error: data.pull_type must be one of ['prequal', 'hard'], Path: ['data', 'pull_type'], Data: prequalification"
}

401

Unauthorized

application/json

Schema

Schema

messagestring

Example (from schema)

{
  "message": "Unauthorized"
}

429

Too Many Requests

application/json

Schema

Schema

errorstring

Example (from schema)

{
  "error": "Too Many Requests"
}

500

Internal Server Error

application/json

Schema

Schema

messagestring

Example (from schema)

{
  "message": "Agility Server Error"
}