Back to InsightlyGets A List Of Organisations Filtered By Tags
Simple object graphs (excluding TAGS, CUSTOMFIELDS, etc.) are returned if "brief=true" is used in the query string.
Input
type: object
properties:
parameters:
type: object
properties:
tagName:
type: string
description: Tag name to filter on
brief:
type: string
description: >-
Optional, true if response should only contain top level properties of
the record.
skip:
type: string
description: Optional, number of records to skip.
top:
type: string
description: Optional, maximum number of records to return in the response.
count_total:
type: string
description: >-
Optional, true if total number of records should be returned in the
response headers.
required:
- tagName
title: Parameters
Output
type: array
items:
type: object
title: Organisation
properties:
ORGANISATION_ID:
format: int64
maxLength: 0
type: integer
readOnly: true
ORGANISATION_NAME:
format: string
maxLength: 255
type: string
readOnly: false
BACKGROUND:
format: string
maxLength: 4000
type: string
readOnly: false
IMAGE_URL:
format: string
maxLength: 500
type: string
readOnly: false
OWNER_USER_ID:
format: int32
maxLength: 0
type: integer
readOnly: false
DATE_CREATED_UTC:
format: date-time
maxLength: 0
type: string
readOnly: true
DATE_UPDATED_UTC:
format: date-time
maxLength: 0
type: string
readOnly: true
LAST_ACTIVITY_DATE_UTC:
format: date-time
maxLength: 0
type: string
readOnly: true
NEXT_ACTIVITY_DATE_UTC:
format: date-time
maxLength: 0
type: string
readOnly: true
CREATED_USER_ID:
format: int32
maxLength: 0
type: integer
readOnly: true
PHONE:
format: string
maxLength: 255
type: string
readOnly: false
PHONE_FAX:
format: string
maxLength: 255
type: string
readOnly: false
WEBSITE:
format: string
maxLength: 255
type: string
readOnly: false
ADDRESS_BILLING_STREET:
format: string
maxLength: 255
type: string
readOnly: false
ADDRESS_BILLING_CITY:
format: string
maxLength: 255
type: string
readOnly: false
ADDRESS_BILLING_STATE:
format: string
maxLength: 255
type: string
readOnly: false
ADDRESS_BILLING_COUNTRY:
format: string
maxLength: 255
type: string
readOnly: false
ADDRESS_BILLING_POSTCODE:
format: string
maxLength: 128
type: string
readOnly: false
ADDRESS_SHIP_STREET:
format: string
maxLength: 255
type: string
readOnly: false
ADDRESS_SHIP_CITY:
format: string
maxLength: 255
type: string
readOnly: false
ADDRESS_SHIP_STATE:
format: string
maxLength: 255
type: string
readOnly: false
ADDRESS_SHIP_POSTCODE:
format: string
maxLength: 128
type: string
readOnly: false
ADDRESS_SHIP_COUNTRY:
format: string
maxLength: 255
type: string
readOnly: false
SOCIAL_LINKEDIN:
format: string
maxLength: 255
type: string
readOnly: false
SOCIAL_FACEBOOK:
format: string
maxLength: 255
type: string
readOnly: false
SOCIAL_TWITTER:
format: string
maxLength: 255
type: string
readOnly: false
CUSTOMFIELDS:
type: array
items:
type: object
title: CustomField
properties:
FIELD_NAME:
type: string
FIELD_VALUE:
type: object
TAGS:
type: array
items:
type: object
title: Tag
properties:
TAG_NAME:
maxLength: 255
minLength: 0
type: string
DATES:
type: array
items:
type: object
title: Date
properties:
DATE_ID:
format: int64
type: integer
OCCASION_NAME:
maxLength: 255
minLength: 0
type: string
OCCASION_DATE:
format: date-time
type: string
REPEAT_YEARLY:
type: boolean
CREATE_TASK_YEARLY:
type: boolean
EMAILDOMAINS:
type: array
items:
type: object
title: EmailDomain
properties:
EMAIL_DOMAIN_ID:
format: int64
type: integer
EMAIL_DOMAIN:
maxLength: 255
minLength: 0
type: string
LINKS:
type: array
items:
type: object
properties:
LINK_ID:
format: int64
type: integer
OBJECT_NAME:
type: string
OBJECT_ID:
format: int64
type: integer
LINK_OBJECT_NAME:
type: string
LINK_OBJECT_ID:
format: int64
type: integer
ROLE:
maxLength: 255
minLength: 0
type: string
DETAILS:
maxLength: 255
minLength: 0
type: string
RELATIONSHIP_ID:
format: int64
type: integer
IS_FORWARD:
type: boolean