Get files table - HelpYouSponsor Docs

GET

files

{type}

{id}

table

Get files table

curl --request GET \
  --url https://api.helpyousponsor.com/v1/files/{type}/{id}/table \
  --header 'X-HYS-API-Key: <api-key>'

{
  "files": [
    {}
  ],
  "box_exists": true,
  "type": "<string>",
  "s": "<string>",
  "n": 123,
  "id": 123,
  "sponsors": [
    {}
  ],
  "entities": [
    {}
  ],
  "useBox": true
}

Authorizations

X-HYS-API-Key

string

header

required

API key generated from Developer Settings. Format: hys_...

Path Parameters

type

string

required

Type of the file (entity or donor)

integer

required

ID of the entity or donor

Response

Successful operation

files

object[]

box_exists

boolean

type

string

integer

sponsors

object[]

entities

object[]

useBox

boolean

Import CSV for a specific program

Get files table

curl --request GET \
  --url https://api.helpyousponsor.com/v1/files/{type}/{id}/table \
  --header 'X-HYS-API-Key: <api-key>'

{
  "files": [
    {}
  ],
  "box_exists": true,
  "type": "<string>",
  "s": "<string>",
  "n": 123,
  "id": 123,
  "sponsors": [
    {}
  ],
  "entities": [
    {}
  ],
  "useBox": true
}