GET Customer/bysurname?offset={offset}&length={length}&surname={surname}&branchid={branchid}

Gets Customers data filtered by surname and branch id (optional).

Request Information

URI Parameters

Name	Description	Type	Additional information
offset	Indicates how many result to skip	integer	Required
length	Indicates how many result to keep	integer	Required
surname	Indicates all or part of customer surname	string	Required
branchid	Indicates the id of the branch	decimal number	Default value is 0

Body Parameters

None.

Response Information

Resource Description

Array with Customers data received and processed

Collection of Customer

Name	Type	Additional information
id	string	None.
lastname	string	None.
firstname	string	None.
dob	date	None.
birthplace	string	None.
email	string	None.
gender	string	None.
address	string	None.
zipcode	string	None.
medicalexpirydate	date	None.
city	string	None.
state	string	None.
phone	string	None.
notes	string	None.
taxcode	string	None.
badgeid	string	None.
memexpirydate	date	None.
typerow	string	None.
ecommerce	boolean	None.
mobilephone	string	None.
medicalexpirydate2	date	None.
vatcode	string	None.
insertdate	date	None.
employee	boolean	None.
customerstate	string	None.
statscurrentseason	decimal number	None.
statspastseason	decimal number	None.
statslast3months	decimal number	None.
statslast6months	decimal number	None.
debt	decimal number	None.
lastaccess	date	None.
lastedit	date	None.
activityexpiredate	date	None.
marketingagreement	boolean	None.
notifyagreement	boolean	None.
lastlogin	date	None.
myzoneid	string	None.
massivedeleteid	decimal number	None.
progressive	integer	None.
userowner	string	None.
userassignee	string	None.
branch	Collection of Branch	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": "sample string 1",
    "lastname": "sample string 2",
    "firstname": "sample string 3",
    "dob": "2025-11-02T03:51:32.1915371+01:00",
    "birthplace": "sample string 4",
    "email": "sample string 5",
    "gender": "sample string 6",
    "address": "sample string 7",
    "zipcode": "sample string 8",
    "medicalexpirydate": "2025-11-02T03:51:32.1915371+01:00",
    "city": "sample string 9",
    "state": "sample string 10",
    "phone": "sample string 11",
    "notes": "sample string 12",
    "taxcode": "sample string 13",
    "badgeid": "sample string 14",
    "memexpirydate": "2025-11-02T03:51:32.1915371+01:00",
    "typerow": "sample string 15",
    "ecommerce": true,
    "mobilephone": "sample string 16",
    "medicalexpirydate2": "2025-11-02T03:51:32.1915371+01:00",
    "vatcode": "sample string 17",
    "insertdate": "2025-11-02T03:51:32.1915371+01:00",
    "employee": true,
    "customerstate": "sample string 20",
    "statscurrentseason": 21.0,
    "statspastseason": 22.0,
    "statslast3months": 23.0,
    "statslast6months": 24.0,
    "debt": 25.0,
    "lastaccess": "2025-11-02T03:51:32.1915371+01:00",
    "lastedit": "2025-11-02T03:51:32.1915371+01:00",
    "activityexpiredate": "2025-11-02T03:51:32.1915371+01:00",
    "marketingagreement": true,
    "notifyagreement": true,
    "lastlogin": "2025-11-02T03:51:32.1915371+01:00",
    "myzoneid": "sample string 26",
    "massivedeleteid": 1.0,
    "progressive": 1,
    "userowner": "sample string 27",
    "userassignee": "sample string 28",
    "branch": [
      {
        "id": "sample string 1",
        "name": "sample string 2",
        "ecomm_name": "sample string 3"
      },
      {
        "id": "sample string 1",
        "name": "sample string 2",
        "ecomm_name": "sample string 3"
      }
    ]
  },
  {
    "id": "sample string 1",
    "lastname": "sample string 2",
    "firstname": "sample string 3",
    "dob": "2025-11-02T03:51:32.1915371+01:00",
    "birthplace": "sample string 4",
    "email": "sample string 5",
    "gender": "sample string 6",
    "address": "sample string 7",
    "zipcode": "sample string 8",
    "medicalexpirydate": "2025-11-02T03:51:32.1915371+01:00",
    "city": "sample string 9",
    "state": "sample string 10",
    "phone": "sample string 11",
    "notes": "sample string 12",
    "taxcode": "sample string 13",
    "badgeid": "sample string 14",
    "memexpirydate": "2025-11-02T03:51:32.1915371+01:00",
    "typerow": "sample string 15",
    "ecommerce": true,
    "mobilephone": "sample string 16",
    "medicalexpirydate2": "2025-11-02T03:51:32.1915371+01:00",
    "vatcode": "sample string 17",
    "insertdate": "2025-11-02T03:51:32.1915371+01:00",
    "employee": true,
    "customerstate": "sample string 20",
    "statscurrentseason": 21.0,
    "statspastseason": 22.0,
    "statslast3months": 23.0,
    "statslast6months": 24.0,
    "debt": 25.0,
    "lastaccess": "2025-11-02T03:51:32.1915371+01:00",
    "lastedit": "2025-11-02T03:51:32.1915371+01:00",
    "activityexpiredate": "2025-11-02T03:51:32.1915371+01:00",
    "marketingagreement": true,
    "notifyagreement": true,
    "lastlogin": "2025-11-02T03:51:32.1915371+01:00",
    "myzoneid": "sample string 26",
    "massivedeleteid": 1.0,
    "progressive": 1,
    "userowner": "sample string 27",
    "userassignee": "sample string 28",
    "branch": [
      {
        "id": "sample string 1",
        "name": "sample string 2",
        "ecomm_name": "sample string 3"
      },
      {
        "id": "sample string 1",
        "name": "sample string 2",
        "ecomm_name": "sample string 3"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfCustomer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sportrick.ApiModel">
  <Customer>
    <activityexpiredate>2025-11-02T03:51:32.1915371+01:00</activityexpiredate>
    <address>sample string 7</address>
    <badgeid>sample string 14</badgeid>
    <birthplace>sample string 4</birthplace>
    <branch>
      <Branch>
        <ecomm_name>sample string 3</ecomm_name>
        <id>sample string 1</id>
        <name>sample string 2</name>
      </Branch>
      <Branch>
        <ecomm_name>sample string 3</ecomm_name>
        <id>sample string 1</id>
        <name>sample string 2</name>
      </Branch>
    </branch>
    <city>sample string 9</city>
    <customerstate>sample string 20</customerstate>
    <debt>25</debt>
    <dob>2025-11-02T03:51:32.1915371+01:00</dob>
    <ecommerce>true</ecommerce>
    <email>sample string 5</email>
    <employee>true</employee>
    <firstname>sample string 3</firstname>
    <gender>sample string 6</gender>
    <id>sample string 1</id>
    <insertdate>2025-11-02T03:51:32.1915371+01:00</insertdate>
    <lastaccess>2025-11-02T03:51:32.1915371+01:00</lastaccess>
    <lastedit>2025-11-02T03:51:32.1915371+01:00</lastedit>
    <lastlogin>2025-11-02T03:51:32.1915371+01:00</lastlogin>
    <lastname>sample string 2</lastname>
    <marketingagreement>true</marketingagreement>
    <massivedeleteid>1</massivedeleteid>
    <medicalexpirydate>2025-11-02T03:51:32.1915371+01:00</medicalexpirydate>
    <medicalexpirydate2>2025-11-02T03:51:32.1915371+01:00</medicalexpirydate2>
    <memexpirydate>2025-11-02T03:51:32.1915371+01:00</memexpirydate>
    <mobilephone>sample string 16</mobilephone>
    <myzoneid>sample string 26</myzoneid>
    <notes>sample string 12</notes>
    <notifyagreement>true</notifyagreement>
    <phone>sample string 11</phone>
    <progressive>1</progressive>
    <state>sample string 10</state>
    <statscurrentseason>21</statscurrentseason>
    <statslast3months>23</statslast3months>
    <statslast6months>24</statslast6months>
    <statspastseason>22</statspastseason>
    <taxcode>sample string 13</taxcode>
    <typerow>sample string 15</typerow>
    <userassignee>sample string 28</userassignee>
    <userowner>sample string 27</userowner>
    <vatcode>sample string 17</vatcode>
    <zipcode>sample string 8</zipcode>
  </Customer>
  <Customer>
    <activityexpiredate>2025-11-02T03:51:32.1915371+01:00</activityexpiredate>
    <address>sample string 7</address>
    <badgeid>sample string 14</badgeid>
    <birthplace>sample string 4</birthplace>
    <branch>
      <Branch>
        <ecomm_name>sample string 3</ecomm_name>
        <id>sample string 1</id>
        <name>sample string 2</name>
      </Branch>
      <Branch>
        <ecomm_name>sample string 3</ecomm_name>
        <id>sample string 1</id>
        <name>sample string 2</name>
      </Branch>
    </branch>
    <city>sample string 9</city>
    <customerstate>sample string 20</customerstate>
    <debt>25</debt>
    <dob>2025-11-02T03:51:32.1915371+01:00</dob>
    <ecommerce>true</ecommerce>
    <email>sample string 5</email>
    <employee>true</employee>
    <firstname>sample string 3</firstname>
    <gender>sample string 6</gender>
    <id>sample string 1</id>
    <insertdate>2025-11-02T03:51:32.1915371+01:00</insertdate>
    <lastaccess>2025-11-02T03:51:32.1915371+01:00</lastaccess>
    <lastedit>2025-11-02T03:51:32.1915371+01:00</lastedit>
    <lastlogin>2025-11-02T03:51:32.1915371+01:00</lastlogin>
    <lastname>sample string 2</lastname>
    <marketingagreement>true</marketingagreement>
    <massivedeleteid>1</massivedeleteid>
    <medicalexpirydate>2025-11-02T03:51:32.1915371+01:00</medicalexpirydate>
    <medicalexpirydate2>2025-11-02T03:51:32.1915371+01:00</medicalexpirydate2>
    <memexpirydate>2025-11-02T03:51:32.1915371+01:00</memexpirydate>
    <mobilephone>sample string 16</mobilephone>
    <myzoneid>sample string 26</myzoneid>
    <notes>sample string 12</notes>
    <notifyagreement>true</notifyagreement>
    <phone>sample string 11</phone>
    <progressive>1</progressive>
    <state>sample string 10</state>
    <statscurrentseason>21</statscurrentseason>
    <statslast3months>23</statslast3months>
    <statslast6months>24</statslast6months>
    <statspastseason>22</statspastseason>
    <taxcode>sample string 13</taxcode>
    <typerow>sample string 15</typerow>
    <userassignee>sample string 28</userassignee>
    <userowner>sample string 27</userowner>
    <vatcode>sample string 17</vatcode>
    <zipcode>sample string 8</zipcode>
  </Customer>
</ArrayOfCustomer>